docs: AI-discovery pass (sitemap, FAQ, metadata, positioning)#191
Merged
Conversation
- VitePress sitemap (hostname) + srcExclude README; sharper site-wide description - homepage hero leads with the Redis-free / your-DB wedge; fix stale 'soon MongoDB' (already supported); add SEO description; feature cards mention atomic claiming and no-Redis - FAQ: add high-intent questions (needs Redis? runs on Bun? production-ready? vs BullMQ/pg-boss?) and a keyword-rich description - add missing frontmatter (title/description) to queue concurrency/priority/states pages; improve queues index description - remove recipes 'work in progress' banner; reframe 'who this is for' so it does not self-cap at small teams
GiovaniGuizzo
approved these changes
Jun 21, 2026
merencia
added a commit
that referenced
this pull request
Jun 22, 2026
…cache Master CI went red after merging #189/#190/#191 (all individually green, docs/metadata-only changes). The build job passed, but lint/test/integration failed with missing build outputs (unresolved types; 'Cannot find module .../sidequest/dist/index.cjs'). Root cause: the setup action cached build outputs (**/dist) and the downstream jobs (which do not build) restored them via actions/cache. That cross-job cache handoff is unreliable: even after the build job saved the cache successfully, a downstream job starting seconds later got a cache miss (GitHub Actions cache read-after-write inconsistency, surfacing now that runners were force-migrated to Node 24). A miss left the job with no dist, so type-aware lint and the tests broke. Fix: stop sharing dist across jobs. Cache only dependencies, keyed on the lockfile (stable, high reuse), and have setup always run 'yarn build' so every job has a freshly built workspace. Builds are fast via Turbo. Also switches the deprecated --frozen-lockfile to --immutable.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A discovery/AI-friendliness pass over the docs, driven by an audit (and by a real Gemini answer that hallucinated Sidequest as 'Bun-only / in-memory').
sitemap.hostnameso docs.sidequestjs.com emits a sitemap (37 URLs). Excludes the stray/READMEpage viasrcExclude.description; feature cards now mention atomic claiming (SELECT ... FOR UPDATE SKIP LOCKED) and 'No Redis Required'.title/descriptionfrontmatter to concurrency/priority/states; sharpen the queues index description; fix a 'limit ... limit' typo.Why
These pages are what LLMs crawl when grounded. Accurate, keyword-aligned, misconception-correcting content is what makes an AI recommend Sidequest correctly instead of guessing.
Validation
vitepress buildpasses (dead-link check + sitemap generation). The migration-guide links point to the absolute docs URL because that page ships in #189; they resolve once both merge.